---
created:
  source_filename: /home/runner/work/mknodes/mknodes/mknodes/pages/mkclasspage/__init__.py
  source_function: MkClassPage.__init__
  source_line_no: 46
hide:
- toc
icon: octicons/table-24
template: SUMMARY.html
title: MkTable
---

[:fa-brands-github: Show source on GitHub](https://github.com/phil65/mknodes/blob/main/mknodes/basenodes/mktable/__init__.py)

### Class representing a formatted table.


=== "Examples"
    ### Example: **Regular**
    !!! jinja "Jinja"
        ``` {.jinja }
        {{ {"Column A": ["A", "B", "C"], "Column B": ["C", "D", "E"]} | MkTable }}

        ```

    !!! python "Python"
        ``` {.python }
        MkTable(data={'Column A': ['A', 'B', 'C'], 'Column B': ['C', 'D', 'E']})
        ```

    ===! "Rendered"
        | Column A | Column B |
        | -------- | -------- |
        | A        | C        |
        | B        | D        |
        | C        | E        |

    === "Markdown"
        ``` {.markdown }
        | Column A | Column B |
        | -------- | -------- |
        | A        | C        |
        | B        | D        |
        | C        | E        |

        ```

    === "Html"
        ``` {.html }
        <table>
        <thead>
        <tr>
        <th>Column A</th>
        <th>Column B</th>
        </tr>
        </thead>
        <tbody>
        <tr>
        <td>A</td>
        <td>C</td>
        </tr>
        <tr>
        <td>B</td>
        <td>D</td>
        </tr>
        <tr>
        <td>C</td>
        <td>E</td>
        </tr>
        </tbody>
        </table>
        ```

    === "Repr tree"
        ```
        MkTable
        ├── MkText('A')
        ├── MkText('B')
        ├── MkText('C')
        ├── MkText('C')
        ├── MkText('D')
        ╰── MkText('E')
        ```


=== "DocStrings"
    ::: mknodes.MkTable
        options:
          show_docstring_description: False



=== "Base classes"
    | Name | Children | Inherits |
    |--- | --- | --- |
    | **<font size='4'>[MkBaseTable](https://phil65.github.io/mknodes/)</font>**<br>*<font size='1'>mknodes.basenodes.mkbasetable</font>*<br>Base Class for MkTables\. Only deals with managing the data\. | <ul><li>[MkTable](https://phil65.github.io/mknodes/)</li><li>[MkHtmlTable](https://phil65.github.io/mknodes/)</li></ul> | <ul><li>[MkContainer](https://phil65.github.io/mknodes/)</li></ul> |

=== "⋔ Inheritance diagram"
    ``` mermaid
    graph TD
      94420314289568["mktable.MkTable"]
      94420314009072["mkbasetable.MkBaseTable"]
      94420312299136["mkcontainer.MkContainer"]
      94420313076768["mknode.MkNode"]
      94420313236736["node.Node"]
      140608527347936["builtins.object"]
      94420314009072 --> 94420314289568
      94420312299136 --> 94420314009072
      94420313076768 --> 94420312299136
      94420313236736 --> 94420313076768
      140608527347936 --> 94420313236736
    ```
=== "NodeFile"
    ``` {.toml  title='/home/runner/work/mknodes/mknodes/mknodes/basenodes/mktable/metadata.toml'}
    [metadata]
    icon = "octicon:table-24"
    name = "MkTable"

    [requirements.extension.tables]

    [examples.regular]
    title = "Regular"
    jinja = """
    {{ {"Column A": ["A", "B", "C"], "Column B": ["C", "D", "E"]} | MkTable }}
    """

    [example.list_of_dicts]
    title = "From list of dicts"
    jinja = """
    {{ [{"col 1": "abc", "col 2": "cde"}, {"col 1": "fgh", "col 2": "ijk"}] | MkTable }}
    """

    # [output.markdown]
    # template = """
    # {% for k in table_data.keys() %}
    # {% endfor %}
    # {% for row in self.iter_rows() %}
    # {% endfor %}

    # """

    ```
=== "Code"
    ``` {.python  title='mknodes.basenodes.mktable.MkTable' linenums='10'}
    class MkTable(mkbasetable.MkBaseTable):
        """Class representing a formatted table."""

        REQUIRED_EXTENSIONS = [resources.Extension("tables")]

        def _to_markdown(self) -> str:
            table_data = self.data  # property
            if not any(table_data[k] for k in table_data):
                return ""
            widths = [self.width_for_column(c) for c in table_data]
            formatters = [f"{{:<{width}}}" for width in widths]
            headers = [formatters[i].format(k) for i, k in enumerate(table_data.keys())]
            divider = [width * "-" for width in widths]
            data = [
                [
                    formatters[i].format(str(k).replace("\n", "<br>"))
                    for i, k in enumerate(row)
                ]
                for row in self.iter_rows()
            ]
            header_txt = "| " + " | ".join(headers) + " |"
            divider_text = "| " + " | ".join(divider) + " |"
            data_txt = ["| " + " | ".join(line) + " |" for line in data]
            return "\n".join([header_txt, divider_text, *data_txt]) + "\n"

    ```